5 Configuration file format
This chapter contains details of the format of the configuration file.
Strings can include PowerShell environment variables (such as $HOME or $env:COMPUTERNAME).
Computers can consist of any combination of fully qualified domain names, or IP addresses. To disable testing a specific computer, you can use an empty or $null string.
5.1 OperatingMode section
Option |
Description |
Allowed values |
Comments |
---|---|---|---|
Mode |
SIU operating mode. |
Local, RemoteWithSameCredentials or RemoteWithDifferentCredentials |
This is a mandatory field. For remote testing, specify whether to supply administrative credentials for the SIU to use on all computers: (RemoteWithSameCredentials) or each tier separately: (RemoteWithDifferentCredentials). |
RunAs |
Run tests in the context of user(s). |
Installation User, Installation User / MyID Com Plus User |
This is a mandatory field. You can set to Installation User / MyID Com Plus User, which will request credentials for the MyID Com Plus User and allow test ID 259 (Get BOL Status) to be run (supported only in Local Mode). |
5.2 Computers section
Option |
Description |
Allowed values |
Comments |
---|---|---|---|
Clients |
Hostname or IP address of each Client computer under test. |
String, comma-separated strings, empty string, or $null |
This is a mandatory field if testing locally and this computer is a Client. At least one field from the Computers group is mandatory. Blank fields will cause the test coverage to be reduced significantly. |
WebServers |
Hostname or IP address of each Web Server computer under test. |
String, comma-separated strings, empty string, or $null |
This is a mandatory field if testing locally and this computer is a Web Server. At least one field from the Computers group is mandatory. Blank fields will cause the test coverage to be reduced significantly. |
AppServers |
Hostname or IP address of each Application Server computer under test. |
String, comma-separated strings, empty string, or $null |
This is a mandatory field if MyID is installed. This is a mandatory field if testing locally and this computer is an Application Server. At least one field from the Computers group is mandatory. Blank fields will cause the test coverage to be reduced significantly. |
Databases |
Hostname or IP address of each Database computer, cluster, or SQL Azure instance under test. |
String, comma-separated strings, empty string, or $null |
This is a mandatory field if testing locally and this computer is a Database. At least one field from the Computers group is mandatory. Blank fields will cause the test coverage to be reduced significantly. |
DomainControllers |
Hostname or IP address of each Domain Controller computer under test. |
String, comma-separated strings, empty string, or $null |
This is a mandatory field if testing locally and this computer is a Domain Controller. At least one field from the Computers group is mandatory. Blank fields will cause the test coverage to be reduced significantly. |
5.3 Users section
Option |
Description |
Allowed values |
Comments |
---|---|---|---|
MyIDComPlusUser |
Name of COM+ user (domain account). |
String |
This is a mandatory field. Specify the user without the domain name. |
IISUser |
Name of IIS user (domain account). |
String |
This is a mandatory field. Specify the user without the domain name. |
WebServiceUser |
Name of web service user (domain account). |
String |
This is a mandatory field. Specify the user without the domain name. If you are testing MyID 10.6 or earlier, specify a dummy user and ignore the associated results, as this user is not relevant. |
InstallationUser |
Name of the installation user (domain account). |
String |
Optional. Specify the user without the domain name. You may need to add the installation user to the configuration file if you are running the SIU non-interactively and see errors relating to the installation user; for example, test 44. |
AuthWSUser |
Name of the authentication web service user (domain account) |
String |
This is a mandatory field. Specify the user without the domain name. |
5.4 SQLSettings section
Option |
Description |
Allowed values |
Comments |
---|---|---|---|
DBTypeAndAuth |
Means of hosting the database and authentication. |
None, SQL Server with Windows Auth (Mutual) or SQL Azure with SQL Server Auth (NoAuth) |
This is a mandatory field. |
MainDB |
Name of main database. |
String |
This is a mandatory field if MyID is installed. Blank fields will cause the test coverage to be reduced significantly. |
ArchiveDB |
Name of archive database (if used). |
String, empty string, or $null |
This is an optional field. Blank fields will cause the test coverage to be reduced significantly. |
AuthDB |
Name of authentication database |
String |
This is a mandatory field if MyID is installed. |
5.5 IISSettings section
Option |
Description |
Allowed values |
Comments |
---|---|---|---|
IISProtocol |
IIS protocols enabled. |
None, HTTPS, HTTPS + HTTP or HTTP |
This is a mandatory field. |
IISWebsite |
Name of the website for use with MyID. |
String |
This is a mandatory field. IIS typically uses Default Web Site. |
5.6 Ports section
Option |
Description |
Allowed values |
Comments |
---|---|---|---|
SQLPortTCP |
Specifies the SQL Server port to use. |
Integer |
This is a mandatory field. Defaults to 1433. |
IISPortHTTP |
Specifies the IIS Server port for HTTP. |
Integer |
This is a mandatory field. Defaults to 80. |
IISPortHTTPS |
Specifies the IIS Server port for HTTPS. |
Integer |
This is a mandatory field. Defaults to 443. |
5.7 Output section
Option |
Description |
Allowed values |
Comments |
---|---|---|---|
ExecuteTestIDs |
Specifies which tests will be executed. |
All or comma-separated string containing range of test IDs and/or specific test IDs |
This is a mandatory field. All tests will be executed if set to All. You may specify a range of test IDs and/or specific test IDs to be executed, for example 001-003, 005, 010-142. |
CustomerName |
Name of your organization to include in the filename of the HTML 5 reports (for reference only). |
String |
This is a mandatory field. |
EnvironmentType |
Brief description of your environment to include in the filename of the HTML 5 reports (for reference only). |
Production or PreProduction |
This is a mandatory field. |
HideUnimportantResults |
Hides unimportant results (Not Run and Can't Test) from reports for clarity. |
True or False |
This is an optional field. |